<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>NTEventLogAppender xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/nt/NTEventLogAppender.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a>   <em class="comment"> * </em>
<a name="9" href="#9">9</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a>  <em class="comment"> * </em>
<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a>  <em class="comment"> */</em>
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.nt;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong>import</strong> org.apache.log4j.AppenderSkeleton;
<a name="21" href="#21">21</a>  <strong>import</strong> org.apache.log4j.Layout;
<a name="22" href="#22">22</a>  <strong>import</strong> org.apache.log4j.TTCCLayout;
<a name="23" href="#23">23</a>  <strong>import</strong> org.apache.log4j.helpers.LogLog;
<a name="24" href="#24">24</a>  <strong>import</strong> org.apache.log4j.spi.LoggingEvent;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em>   Append to the NT event log system.</em>
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  <em>   &lt;p>&lt;b>WARNING&lt;/b> This appender can only be installed and used on a</em>
<a name="31" href="#31">31</a>  <em>   Windows system.</em>
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em>   &lt;p>Do not forget to place the file NTEventLogAppender.dll in a</em>
<a name="34" href="#34">34</a>  <em>   directory that is on the PATH of the Windows system. Otherwise, you</em>
<a name="35" href="#35">35</a>  <em>   will get a java.lang.UnsatisfiedLinkError.</em>
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em>   @author &lt;a href="<a href="mailto:cstaylor@pacbell.net" target="alexandria_uri">mailto:cstaylor@pacbell.net</a>">Chris Taylor&lt;/a></em>
<a name="38" href="#38">38</a>  <em>   @author &lt;a href="<a href="mailto:jim_cakalic@na.biomerieux.com" target="alexandria_uri">mailto:jim_cakalic@na.biomerieux.com</a>">Jim Cakalic&lt;/a> */</em>
<a name="39" href="#39">39</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a> <strong>extends</strong> <a href="../../../../org/apache/log4j/AppenderSkeleton.html">AppenderSkeleton</a> {
<a name="40" href="#40">40</a>    <strong>private</strong> <strong>int</strong> _handle = 0;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>    <strong>private</strong> String source = <strong>null</strong>;
<a name="43" href="#43">43</a>    <strong>private</strong> String server = <strong>null</strong>;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>() {
<a name="47" href="#47">47</a>      <strong>this</strong>(<strong>null</strong>, <strong>null</strong>, <strong>null</strong>);
<a name="48" href="#48">48</a>    }
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>(String source) {
<a name="51" href="#51">51</a>      <strong>this</strong>(<strong>null</strong>, source, <strong>null</strong>);
<a name="52" href="#52">52</a>    }
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>(String server, String source) {
<a name="55" href="#55">55</a>      <strong>this</strong>(server, source, <strong>null</strong>);
<a name="56" href="#56">56</a>    }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>(<a href="../../../../org/apache/log4j/Layout.html">Layout</a> layout) {
<a name="59" href="#59">59</a>      <strong>this</strong>(<strong>null</strong>, <strong>null</strong>, layout);
<a name="60" href="#60">60</a>    }
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>(String source, <a href="../../../../org/apache/log4j/Layout.html">Layout</a> layout) {
<a name="63" href="#63">63</a>      <strong>this</strong>(<strong>null</strong>, source, layout);
<a name="64" href="#64">64</a>    }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>    <strong>public</strong> <a href="../../../../org/apache/log4j/nt/NTEventLogAppender.html">NTEventLogAppender</a>(String server, String source, <a href="../../../../org/apache/log4j/Layout.html">Layout</a> layout) {
<a name="67" href="#67">67</a>      <strong>if</strong> (source == <strong>null</strong>) {
<a name="68" href="#68">68</a>        source = <span class="string">"Log4j"</span>;
<a name="69" href="#69">69</a>      }
<a name="70" href="#70">70</a>      <strong>if</strong> (layout == <strong>null</strong>) {
<a name="71" href="#71">71</a>        <strong>this</strong>.layout = <strong>new</strong> <a href="../../../../org/apache/log4j/TTCCLayout.html">TTCCLayout</a>();
<a name="72" href="#72">72</a>      } <strong>else</strong> {
<a name="73" href="#73">73</a>        <strong>this</strong>.layout = layout;
<a name="74" href="#74">74</a>      }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong>try</strong> {
<a name="77" href="#77">77</a>        _handle = registerEventSource(server, source);
<a name="78" href="#78">78</a>      } <strong>catch</strong> (Exception e) {
<a name="79" href="#79">79</a>        e.printStackTrace();
<a name="80" href="#80">80</a>        _handle = 0;
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>    }
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>    <strong>public</strong>
<a name="85" href="#85">85</a>    <strong>void</strong> close() {
<a name="86" href="#86">86</a>      <em class="comment">// unregister ...</em>
<a name="87" href="#87">87</a>    }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>    <strong>public</strong>
<a name="90" href="#90">90</a>    <strong>void</strong> activateOptions() {
<a name="91" href="#91">91</a>      <strong>if</strong> (source != <strong>null</strong>) {
<a name="92" href="#92">92</a>        <strong>try</strong> {
<a name="93" href="#93">93</a>     _handle = registerEventSource(server, source);
<a name="94" href="#94">94</a>        } <strong>catch</strong> (Exception e) {
<a name="95" href="#95">95</a>     LogLog.error(<span class="string">"Could not register event source."</span>, e);
<a name="96" href="#96">96</a>     _handle = 0;
<a name="97" href="#97">97</a>        }
<a name="98" href="#98">98</a>      }
<a name="99" href="#99">99</a>    }
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>   <strong>public</strong> <strong>void</strong> append(<a href="../../../../org/apache/log4j/spi/LoggingEvent.html">LoggingEvent</a> event) {
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     StringBuffer sbuf = <strong>new</strong> StringBuffer();
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     sbuf.append(layout.format(event));
<a name="107" href="#107">107</a>     <strong>if</strong>(layout.ignoresThrowable()) {
<a name="108" href="#108">108</a>       String[] s = event.getThrowableStrRep();
<a name="109" href="#109">109</a>       <strong>if</strong> (s != <strong>null</strong>) {
<a name="110" href="#110">110</a>    <strong>int</strong> len = s.length;
<a name="111" href="#111">111</a>    <strong>for</strong>(<strong>int</strong> i = 0; i &lt; len; i++) {
<a name="112" href="#112">112</a>      sbuf.append(s[i]);
<a name="113" href="#113">113</a>    }
<a name="114" href="#114">114</a>       }
<a name="115" href="#115">115</a>     }
<a name="116" href="#116">116</a>     <em class="comment">// Normalize the log message level into the supported categories</em>
<a name="117" href="#117">117</a>     <strong>int</strong> nt_category = event.getLevel().toInt();
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em class="comment">// Anything above FATAL or below DEBUG is labeled as INFO.</em>
<a name="120" href="#120">120</a>     <em class="comment">//if (nt_category > FATAL || nt_category &lt; DEBUG) {</em>
<a name="121" href="#121">121</a>     <em class="comment">//  nt_category = INFO;</em>
<a name="122" href="#122">122</a>     <em class="comment">//}</em>
<a name="123" href="#123">123</a>     reportEvent(_handle, sbuf.toString(), nt_category);
<a name="124" href="#124">124</a>   }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>   <strong>public</strong>
<a name="128" href="#128">128</a>   <strong>void</strong> finalize() {
<a name="129" href="#129">129</a>     deregisterEventSource(_handle);
<a name="130" href="#130">130</a>     _handle = 0;
<a name="131" href="#131">131</a>   }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>   <em>/**<em>*</em></em>
<a name="134" href="#134">134</a> <em>     The &lt;b>Source&lt;/b> option which names the source of the event. The</em>
<a name="135" href="#135">135</a> <em>     current value of this constant is &lt;b>Source&lt;/b>.</em>
<a name="136" href="#136">136</a> <em>   */</em>
<a name="137" href="#137">137</a>   <strong>public</strong>
<a name="138" href="#138">138</a>   <strong>void</strong> setSource(String source) {
<a name="139" href="#139">139</a>     <strong>this</strong>.source = source.trim();
<a name="140" href="#140">140</a>   }
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>   <strong>public</strong>
<a name="143" href="#143">143</a>   String getSource() {
<a name="144" href="#144">144</a>     <strong>return</strong> source;
<a name="145" href="#145">145</a>   }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a> <em>/**<em>*</em></em>
<a name="148" href="#148">148</a> <em>     The &lt;code>NTEventLogAppender&lt;/code> requires a layout. Hence,</em>
<a name="149" href="#149">149</a> <em>     this method always returns &lt;code>true&lt;/code>. */</em>
<a name="150" href="#150">150</a>   <strong>public</strong>
<a name="151" href="#151">151</a>   <strong>boolean</strong> requiresLayout() {
<a name="152" href="#152">152</a>     <strong>return</strong> <strong>true</strong>;
<a name="153" href="#153">153</a>   }
<a name="154" href="#154">154</a> 
<a name="155" href="#155">155</a>   <strong>native</strong> <strong>private</strong> <strong>int</strong> registerEventSource(String server, String source);
<a name="156" href="#156">156</a>   <strong>native</strong> <strong>private</strong> <strong>void</strong> reportEvent(<strong>int</strong> handle, String message, <strong>int</strong> level);
<a name="157" href="#157">157</a>   <strong>native</strong> <strong>private</strong> <strong>void</strong> deregisterEventSource(<strong>int</strong> handle);
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>   <strong>static</strong> {
<a name="160" href="#160">160</a>     System.loadLibrary(<span class="string">"NTEventLogAppender"</span>);
<a name="161" href="#161">161</a>   }
<a name="162" href="#162">162</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

